doc: clarify bufferline-custom-areas #900
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update text in
bufferline-custom-areas
section.There is an unexplained issue or nuance with the given custom-area example. It is possible for errors to appear with warning/info/hint (or any diagnostic level under any highlight group) due to the way highlight groups are created.
Highlight groups are created on first pass in L21 of method create_hl It is important to note that they are not unset.
For example, if the first diagnostic is a hint, then highlight group
BufferLineRightCustomAreaText1
will be the hint highlight group. Then, if you fix the hint and introduce an error diagnostic, it will appear with the hint highlighting.One solution would be to unset highlight groups and then re-set them during method call. Destroying and creating the highlight groups each time tabline is rendered sounds like an expensive solution.
One workaround is to create the table entries with desired highlights so the
BufferLine[side]CustomAreaTest[number]
groups and insert the text if needed.